home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3 / il / ilSepKernel.z / ilSepKernel
Encoding:
Text File  |  2002-10-03  |  8.6 KB  |  265 lines
  1.  
  2.  
  3.  
  4. iiiillllSSSSeeeeppppKKKKeeeerrrrnnnneeeellll((((3333))))     IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll     iiiillllSSSSeeeeppppKKKKeeeerrrrnnnneeeellll((((3333))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      iiiillllSSSSeeeeppppKKKKeeeerrrrnnnneeeellll - a separable kernel
  10.  
  11. IIIINNNNHHHHEEEERRRRIIIITTTTSSSS FFFFRRRROOOOMMMM
  12.      ilKernel
  13.  
  14. HHHHEEEEAAAADDDDEEEERRRR FFFFIIIILLLLEEEE
  15.      #include <il/ilSepKernel.h>
  16.  
  17. CCCCLLLLAAAASSSSSSSS DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  18.      ilSepKernel implements a separable kernel. A kernel is defined by a data
  19.      type, the sizes of the _x, _y, and _z vectors, and the data for the vectors.
  20.      ilSepKernel also provides functions to access kernel data.
  21.  
  22. CCCCLLLLAAAASSSSSSSS MMMMEEEEMMMMBBBBEEEERRRR FFFFUUUUNNNNCCCCTTTTIIIIOOOONNNN SSSSUUUUMMMMMMMMAAAARRRRYYYY
  23.      CCCCoooonnnnssssttttrrrruuuuccccttttoooorrrr
  24.  
  25.           ilSepKernel(iflDataType type=iflUChar, void *xdata=NULL, int x=1,
  26.                       void *ydata=NULL, int y=1, void *zdata=NULL, int z=1)
  27.  
  28.  
  29.      FFFFuuuunnnnccccttttiiiioooonnnnssss ttttoooo sssseeeetttt////ggggeeeetttt kkkkeeeerrrrnnnneeeellll ddddaaaattttaaaa
  30.  
  31.           void *getXdata()
  32.           void *getYdata()
  33.           void *getZdata()
  34.           void setXdata(void *xKernel)
  35.           void setYdata(void *yKernel)
  36.           void setZdata(void *zKernel)
  37.           double getXelement(int n)
  38.           double getYelement(int n)
  39.           double getZelement(int n)
  40.           void setXelement(double val, int n)
  41.           void setYelement(double val, int n)
  42.           void setZelement(double val, int n)
  43.  
  44.  
  45. FFFFUUUUNNNNCCCCTTTTIIIIOOOONNNN DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNNSSSS
  46.      iiiillllSSSSeeeeppppKKKKeeeerrrrnnnneeeellll(((())))
  47.  
  48.           ilSepKernel(iflDataType type=iflUChar, void *xdata=NULL, int x=1,
  49.                       void *ydata=NULL, int y=1, void *zdata=NULL, int z=1)
  50.  
  51.  
  52.  
  53.  
  54.      Construct a kernel by copying user data into the object.  If any of the
  55.      data pointers is NULL, data is still allocated for the indicated size,
  56.      and the values are initalized to 1. The kernel type is set to
  57.      _i_l_K_e_r_n_S_e_p_a_r_a_b_l_e.
  58.  
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. iiiillllSSSSeeeeppppKKKKeeeerrrrnnnneeeellll((((3333))))     IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll     iiiillllSSSSeeeeppppKKKKeeeerrrrnnnneeeellll((((3333))))
  71.  
  72.  
  73.  
  74.      ggggeeeettttXXXXddddaaaattttaaaa(((())))
  75.  
  76.           void *getXdata()
  77.  
  78.  
  79.           Returns a pointer to the X vector of the kernel.  Use the kernel
  80.           data type to cast the pointer to the correct type.
  81.  
  82.      ggggeeeettttXXXXeeeelllleeeemmmmeeeennnntttt(((())))
  83.  
  84.           double getXelement(int n)
  85.  
  86.  
  87.           Returns the _nth element from the X vector of the kernel.
  88.  
  89.      ggggeeeettttYYYYddddaaaattttaaaa(((())))
  90.  
  91.           void *getYdata()
  92.  
  93.  
  94.           Returns a pointer to the Y vector of the kernel.  Use the kernel
  95.           data type to cast the pointer to the correct type.
  96.  
  97.      ggggeeeettttYYYYeeeelllleeeemmmmeeeennnntttt(((())))
  98.  
  99.           double getYelement(int n)
  100.  
  101.  
  102.           Returns the _nth element from the Y vector of the kernel.
  103.  
  104.      ggggeeeettttZZZZddddaaaattttaaaa(((())))
  105.  
  106.           void *getZdata()
  107.  
  108.  
  109.           Returns a pointer to the Z vector of the kernel.  Use the kernel
  110.           data type to cast the pointer to the correct type.
  111.  
  112.      ggggeeeettttZZZZeeeelllleeeemmmmeeeennnntttt(((())))
  113.  
  114.           double getZelement(int n)
  115.  
  116.  
  117.           Returns the _nth element from the Z vector of the kernel.
  118.  
  119.      sssseeeettttXXXXddddaaaattttaaaa(((())))
  120.  
  121.           void setXdata(void *xKernel)
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. iiiillllSSSSeeeeppppKKKKeeeerrrrnnnneeeellll((((3333))))     IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll     iiiillllSSSSeeeeppppKKKKeeeerrrrnnnneeeellll((((3333))))
  137.  
  138.  
  139.  
  140.           Copies _d_a_t_a into the X vector of the kernel.  The data is assumed to
  141.           be of the type and dimensions corresponding to the size and type
  142.           used in the kernel construction.
  143.  
  144.      sssseeeettttXXXXeeeelllleeeemmmmeeeennnntttt(((())))
  145.  
  146.           void setXelement(double val, int n)
  147.  
  148.  
  149.           Sets the _nth element from the X vector of the kernel to _v_a_l.
  150.  
  151.      sssseeeettttYYYYddddaaaattttaaaa(((())))
  152.  
  153.           void setYdata(void *yKernel)
  154.  
  155.  
  156.           Copies _d_a_t_a into the Y vector of the kernel.  The data is assumed to
  157.           be of the type and dimensions corresponding to the size and type
  158.           used in the kernel construction.
  159.  
  160.      sssseeeettttYYYYeeeelllleeeemmmmeeeennnntttt(((())))
  161.  
  162.           void setYelement(double val, int n)
  163.  
  164.  
  165.           Sets the _nth element from the Y vector of the kernel to _v_a_l.
  166.  
  167.      sssseeeettttZZZZddddaaaattttaaaa(((())))
  168.  
  169.           void setZdata(void *zKernel)
  170.  
  171.  
  172.           Copies _d_a_t_a into the Z vector of the kernel.  The data is assumed to
  173.           be of the type and dimensions corresponding to the size and type
  174.           used in the kernel construction.
  175.  
  176.      sssseeeettttZZZZeeeelllleeeemmmmeeeennnntttt(((())))
  177.  
  178.           void setZelement(double val, int n)
  179.  
  180.  
  181.           Sets the _nth element from the Z vector of the kernel to _v_a_l.
  182.  
  183. IIIINNNNHHHHEEEERRRRIIIITTTTEEEEDDDD MMMMEEEEMMMMBBBBEEEERRRR FFFFUUUUNNNNCCCCTTTTIIIIOOOONNNNSSSS
  184.    IIIInnnnhhhheeeerrrriiiitttteeeedddd ffffrrrroooommmm iiiillllKKKKeeeerrrrnnnneeeellll
  185.      calcGain(), calcPassGain(), copy(), getData(), getDataType(),
  186.      getElement(), getKernelType(), getOrigin(), getSize(), getVal(),
  187.      getXsize(), getYsize(), getZsize(), init(), isClampSet(), isEquivalent(),
  188.      offset(), offset(), operator=(), scale(), setClamp(), setData(),
  189.      setElement(), setOrigin(), setVal()
  190.  
  191.  
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202. iiiillllSSSSeeeeppppKKKKeeeerrrrnnnneeeellll((((3333))))     IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll     iiiillllSSSSeeeeppppKKKKeeeerrrrnnnneeeellll((((3333))))
  203.  
  204.  
  205.  
  206.    IIIInnnnhhhheeeerrrriiiitttteeeedddd ffffrrrroooommmm iiiillllWWWWaaaattttcccchhhheeeeddddOOOObbbbjjjjeeeecccctttt
  207.      addWatchCallback(), doWatchCallbacks(), removeWatchCallback()
  208.  
  209. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  210.      ilKernel, ilSepSharpenKernel
  211.  
  212.  
  213.  
  214.  
  215.  
  216.  
  217.  
  218.  
  219.  
  220.  
  221.  
  222.  
  223.  
  224.  
  225.  
  226.  
  227.  
  228.  
  229.  
  230.  
  231.  
  232.  
  233.  
  234.  
  235.  
  236.  
  237.  
  238.  
  239.  
  240.  
  241.  
  242.  
  243.  
  244.  
  245.  
  246.  
  247.  
  248.  
  249.  
  250.  
  251.  
  252.  
  253.  
  254.  
  255.  
  256.  
  257.  
  258.  
  259.  
  260.  
  261.                                                                         PPPPaaaaggggeeee 4444
  262.  
  263.  
  264.  
  265.